
Security News
Browserslist-rs Gets Major Refactor, Cutting Binary Size by Over 1MB
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
A simple Javascript library implementing the JSON Reference and the JSON Pointer specifications.
$ npm install jsonref
dataOrUri
, the data to parse or a fully qualified URI to pass to retriever
to download the dataoptions
(optional), parsing options, the following optional properties are supported:
scope
, the current resolution scope (base href) of URLs and paths.store
, an object to use to cache resolved id
and $ref
values. If no store is passed,
one is automatically created. Pass a store
if you are going to parse several objects or URIs referencing
the same id
and $ref
values.retriever
, a function accepting a URL in input and returning a promise resolved to an object
representing the data downloaded for the URI. Whenever a $ref
to a new URI is found, if the URI is not
already cached in the store in use, it'll be fetched using this retriever
. If not retriever
is passed
and a URI needs to be downloaded, a no_retriever
exception is thrown.The function returns a Promise resolving to the parsed data, with all $ref
instances resolved.
retriever
using fetch
function retriever(url) {
var opts = {
method: 'GET',
credentials: 'include'
};
return fetch(url, opts).then(function(response) {
return response.json();
});
}
retriever
using request
var request = require('request');
function retriever(url) {
return new Promise(function(resolve, reject) {
request({
url: url,
method: 'GET',
json: true
}, function(err, response, data) {
if (err) {
reject(err);
} else if (response.statusCode !== 200) {
reject(response.statusCode);
} else {
resolve(data);
}
});
});
}
data
, the object to transverse using JSON Pointer.path
, either a string (#/prop1/prop2
) or an array of path components ([ "#", "prop1", "prop2" ]
or [ "prop1", "prop2" ]
).value
, optional, value to set at path
. All missing intermediate path levels are created as well.Returns the data requested or sets a new value at the specified path
var jsonref = require('jsonref');
var schema = {
"id": "http://my.site/myschema#",
"definitions": {
"schema1": {
"id": "schema1",
"type": "integer"
},
"schema2": {
"type": "array",
"items": { "$ref": "schema1" }
}
}
}
jsonref.parse(schema).then(function(result) {
console.log(JSON.stringify(result, null, 2));
});
The output is:
{
"id": "http://my.site/myschema#",
"definitions": {
"schema1": {
"id": "schema1",
"type": "integer"
},
"schema2": {
"type": "array",
"items": {
"id": "schema1",
"type": "integer"
}
}
}
}
var jsonref = require('jsonref');
var schema = {
"allOf": [
{ "$ref": "http://json-schema.org/draft-04/schema#" },
{
"type": "object",
"properties": {
"documentation": {
"type": "string"
}
}
}
]
}
jsonref.parse(schema, {
retriever: retriever
}).then(function(result) {
console.log(JSON.stringify(result, null, 2));
});
The library will call retriever("http://json-schema.org/draft-04/schema#")
to download the external
reference. If no retriever
is passed, the returned value is a rejected Promise, with a no_retriever
exception.
var jsonref = require('jsonref');
var store = {};
var schema = {
"id": "http://my.site/myschema#",
"definitions": {
"schema1": {
"id": "schema1",
"type": "integer"
},
"schema2": {
"type": "array",
"items": { "$ref": "schema1" }
}
}
}
jsonref.parse(schema, {
store: store
}).then(function(result) {
console.log(JSON.stringify(result, null, 2));
});
After parsing, the contents of the store are:
{
"http://my.site/myschema#": {
"id": "http://my.site/myschema#",
"definitions": {
"schema1": {
"id": "schema1",
"type": "integer"
},
"schema2": {
"type": "array",
"items": {
"id": "schema1",
"type": "integer"
}
}
}
},
"http://my.site/schema1#": {
"id": "schema1",
"type": "integer"
}
}
FAQs
Javascript References ($ref) and Pointers library
The npm package jsonref receives a total of 10,965 weekly downloads. As such, jsonref popularity was classified as popular.
We found that jsonref demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
Research
Security News
Eight new malicious Firefox extensions impersonate games, steal OAuth tokens, hijack sessions, and exploit browser permissions to spy on users.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.